Official aws-lite
plugin for API Gateway WebSocket Management API
Maintained by: @architect
Install
npm i @aws-lite/apigatewaymanagementapi
Optionally install types:
npm i -D @aws-lite/apigatewaymanagementapi-types
Reference
Reference documentation with examples at aws-lite.org
Methods
PostToConnection
Canonical AWS API doc
Properties:
ConnectionId
(string) [required]
ApiUrl
(string)
- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
and Stage
; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
ApiId
(string)
Stage
(string)
- API Gateway stage; example:
$default
Data
(string, object)
- Data to send to WebSocket client
DeleteConnection
Canonical AWS API doc
Properties:
ConnectionId
(string) [required]
ApiUrl
(string)
- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
and Stage
; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
ApiId
(string)
Stage
(string)
- API Gateway stage; example:
$default
GetConnection
Canonical AWS API doc
Properties:
ConnectionId
(string) [required]
ApiUrl
(string)
- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
and Stage
; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
ApiId
(string)
Stage
(string)
- API Gateway stage; example:
$default
Learn more